<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class ActionMessages</title>
			<link rel="stylesheet" href="../../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Class ActionMessages</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
													<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
						|											<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">ActionMessages class</p>
		<p class="notes">
			Located in <a class="field" href="_mvc---action---ActionMessages.php.html">/mvc/action/ActionMessages.php</a> (line <span class="field">36</span>)
		</p>
		
				
		<pre></pre>
	
			</div>
</div>



	<a name="sec-var-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Variable Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
						<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
							| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
								</div>
		<div class="info-box-body">
			<div class="var-summary">
																																<div class="var-title">
					<span class="var-type">mixed</span>
					<a href="#$accessed" title="details" class="var-name">$accessed</a>
				</div>
																<div class="var-title">
					<span class="var-type">mixed</span>
					<a href="#$messages" title="details" class="var-name">$messages</a>
				</div>
											</div>
		</div>
	</div>

	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
																		<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
				 
				|
						<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
																																																																				
												<div class="method-definition">
											<span class="method-result">ActionMessages</span>
										<a href="#__construct" title="details" class="method-name">__construct</a>
											([<span class="var-type">messages</span>&nbsp;<span class="var-name">$messages</span> = <span class="var-default">null</span>])
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#add" title="details" class="method-name">add</a>
											(<span class="var-type">property</span>&nbsp;<span class="var-name">$property</span>, <span class="var-type"><a href="../../php-mvc/action/ActionMessage.html">ActionMessage</a></span>&nbsp;<span class="var-name">$message</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#addMessages" title="details" class="method-name">addMessages</a>
											(<span class="var-type">actionMessages</span>&nbsp;<span class="var-name">$actionMessages</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#clear" title="details" class="method-name">clear</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">An</span>
										<a href="#get" title="details" class="method-name">get</a>
											([<span class="var-type"></span>&nbsp;<span class="var-name">$property</span> = <span class="var-default">null</span>])
									</div>
																<div class="method-definition">
											<span class="method-result"><code>true</code></span>
										<a href="#isAccessed" title="details" class="method-name">isAccessed</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result"><code>true</code></span>
										<a href="#isEmpty" title="details" class="method-name">isEmpty</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#__toString" title="details" class="method-name">__toString</a>
										()
									</div>
								</div>
		</div>
	</div>		

	<a name="sec-vars"></a>
	<div class="info-box">
		<div class="info-box-title">Variables</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
										<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
						
			
										| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
			<a name="var$accessed" id="$accessed"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$accessed</span>
			 = <span class="var-default"> false</span>			(line <span class="line-number">48</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">&lt;p&gt;Have the messages been retrieved from this object?&lt;/p&gt;</p>
<p class="description"><p>The controller uses this property to determine if session-scoped  messages can be removed.</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
<a name="var$messages" id="$messages"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$messages</span>
			 = <span class="var-default">array()</span>			(line <span class="line-number">56</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">&lt;p&gt;The accumulated set of <div class="src-code"><ol><li><div class="src-line"><span class="src-id"><a href="../../php-mvc/action/ActionMessage.html">ActionMessage</a></span></div></li>
</ol></div> objects</p>
<p class="description"><p>(represented as an ArrayList) for each property, keyed by property  name.&lt;/p&gt;</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
						
		</div>
	</div>
	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
															<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
																	<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>

<a name="method__construct" id="__construct"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">Constructor __construct</span> (line <span class="line-number">69</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">&lt;p&gt;Create an <div class="src-code"><ol><li><div class="src-line"><span class="src-id"><a href="../../php-mvc/action/ActionMessages.html">ActionMessages</a></span></div></li>
</ol></div> object initialized with the  given messages.&lt;/p&gt;</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">ActionMessages</span>
		<span class="method-name">
			__construct
		</span>
					([<span class="var-type">messages</span>&nbsp;<span class="var-name">$messages</span> = <span class="var-default">null</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">messages</span>
				<span class="var-name">$messages</span><span class="var-description">: The messages to be initially added to this object. This                  parameter can be <div class="src-code"><ol><li><div class="src-line"><span class="src-id">null</span></div></li>
</ol></div>.</span>			</li>
				</ul>
		
			
	</div>
<a name="methodadd" id="add"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">add</span> (line <span class="line-number">114</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">&lt;p&gt;Add a message to the set of messages for the specified property. An  order of the property/key is maintained based on the initial addition  of the property/key.&lt;/p&gt;</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			add
		</span>
					(<span class="var-type">property</span>&nbsp;<span class="var-name">$property</span>, <span class="var-type"><a href="../../php-mvc/action/ActionMessage.html">ActionMessage</a></span>&nbsp;<span class="var-name">$message</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">property</span>
				<span class="var-name">$property</span><span class="var-description">: Property name (or ActionMessages.GLOBAL_MESSAGE)</span>			</li>
					<li>
				<span class="var-type">message</span>
				<span class="var-name">$message</span><span class="var-description">: The message to be added</span>			</li>
				</ul>
		
			
	</div>
<a name="methodaddMessages" id="addMessages"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">addMessages</span> (line <span class="line-number">89</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">&lt;p&gt;Adds the messages from the given <div class="src-code"><ol><li><div class="src-line"><span class="src-id"><a href="../../php-mvc/action/ActionMessages.html">ActionMessages</a></span></div></li>
</ol></div> object</p>
<p class="description"><p>to this set of messages. The messages are added in the order they are  returned from the <div class="src-code"><ol><li><div class="src-line"><span class="src-id">properties</span></div></li>
</ol></div> method. If a message's  property is already in the current <div class="src-code"><ol><li><div class="src-line"><span class="src-id"><a href="../../php-mvc/action/ActionMessages.html">ActionMessages</a></span></div></li>
</ol></div> object,  it is added to the end of the list for that property. If a message's  property is not in the current list it is added to the end of the  properties.&lt;/p&gt;</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			addMessages
		</span>
					(<span class="var-type">actionMessages</span>&nbsp;<span class="var-name">$actionMessages</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">actionMessages</span>
				<span class="var-name">$actionMessages</span><span class="var-description">: The <div class="src-code"><ol><li><div class="src-line"><span class="src-id"><a href="../../php-mvc/action/ActionMessages.html">ActionMessages</a></span></div></li>
</ol></div> object to be                        added. This parameter can be <div class="src-code"><ol><li><div class="src-line"><span class="src-id">null</span></div></li>
</ol></div>.</span>			</li>
				</ul>
		
			
	</div>
<a name="methodclear" id="clear"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">clear</span> (line <span class="line-number">122</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">&lt;p&gt;Clear all messages recorded by this object.&lt;/p&gt;</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			clear
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodget" id="get"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">get</span> (line <span class="line-number">146</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">&lt;p&gt;Return the set of all recorded messages, without distinction by  which property the messages are associated with. If there are no  messages recorded, an empty enumeration is returned.&lt;/p&gt;</p>
	<ul class="tags">
				<li><span class="field">return:</span> iterator over the messages for all properties.</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">An</span>
		<span class="method-name">
			get
		</span>
					([<span class="var-type"></span>&nbsp;<span class="var-name">$property</span> = <span class="var-default">null</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"></span>
				<span class="var-name">$property</span>			</li>
				</ul>
		
			
	</div>
<a name="methodisAccessed" id="isAccessed"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">isAccessed</span> (line <span class="line-number">171</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">&lt;p&gt;Returns <div class="src-code"><ol><li><div class="src-line"><span class="src-id">true</span></div></li>
</ol></div> if the <div class="src-code"><ol><li><div class="src-line"><span class="src-id">get</span><span class="src-sym">(</span><span class="src-sym">)</span></div></li>
</ol></div> or  <div class="src-code"><ol><li><div class="src-line"><span class="src-id">get</span>(String)</div></li>
</ol></div> methods are called.&lt;/p&gt;</p>
	<ul class="tags">
				<li><span class="field">return:</span> if the messages have been accessed one or          more times.</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result"><code>true</code></span>
		<span class="method-name">
			isAccessed
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodisEmpty" id="isEmpty"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">isEmpty</span> (line <span class="line-number">134</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">&lt;p&gt;Return <div class="src-code"><ol><li><div class="src-line"><span class="src-id">true</span></div></li>
</ol></div> if there are no messages recorded in this  collection, or <div class="src-code"><ol><li><div class="src-line"><span class="src-id">false</span></div></li>
</ol></div> otherwise.&lt;/p&gt;</p>
	<ul class="tags">
				<li><span class="field">return:</span> if there are no messages recorded in this          collection; <div class="src-code"><ol><li><div class="src-line"><span class="src-id">false</span></div></li>
</ol></div> otherwise.</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result"><code>true</code></span>
		<span class="method-name">
			isEmpty
		</span>
				()
			</div>
	
		
			
	</div>
<a name="method__toString" id="__toString"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">__toString</span> (line <span class="line-number">176</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			__toString
		</span>
				()
			</div>
	
		
			
	</div>
						
		</div>
	</div>


	<p class="notes" id="credit">
		Documentation generated on Fri, 08 Feb 2008 14:32:34 +0200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
	</p>
	</div></body>
</html>